# -*- coding: utf-8 -*-

#This file is part of pyLot library.
#
# pyLot is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# pyLot is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with pyLot.  If not, see <http://www.gnu.org/licenses/>.

__author__ = u'Pierre Puiseux, Guillaume Baty'
__copyright__ = u"Copyright 2011-2012 (C) andheo, Université de Pau et des Pays de l'Adour"
__credits__ = [u'Pierre Puiseux', u'Guillaume Baty']
__license__ = "GNU Lesser General Public License"

__all__ = ['IDataRepr']

from traits.api import (Interface, Str, Unicode)

class IDataRepr(Interface):
  """
  Whatever the python class
  """

  """plugin identifier. 
  Ex: dataconverter.repr.image"""
  identifier = Str
  example_python = Unicode

  @classmethod
  def new(self):
    """
    Returns a new empty object
    """
    pass

  def sample(self):
    """
    Returns a sample of this DataRepr, ie, like new but not empty.
    """

  def toPyCode(self):
    """
    Returns a string representing code used to generate this instance.
    """
    pass

  def __eq__(self, other):
    """
    Tests object equality.
    """

  def __deepcopy__(self):
    """
    See copy
    """

  def copy(self):
    """
    Returns a copy of this object.
    This method is equivalent to __deepcopy__ method : object returned
    shared absolutely nothing with original one !

    obj.copy() == obj
    True
    obj.copy() is obj
    False
    """
